<!DOCTYPE html>
<html id="docs" lang="en" class="">
	<head>
	<meta charset="utf-8">
<title>Generating Reference Documentation for kubectl Commands - Kubernetes</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="shortcut icon" type="image/png" href="../../../../../images/favicon.png">
<link rel="stylesheet" type="text/css" href="../../../../../css/base_fonts.css">
<link rel="stylesheet" type="text/css" href="../../../../../css/styles.css">
<link rel="stylesheet" type="text/css" href="https://code.jquery.com/ui/1.12.1/themes/smoothness/jquery-ui.css">
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/sweetalert/1.1.3/sweetalert.min.css">
<link rel="stylesheet" type="text/css" href="../../../../../css/callouts.css">
<link rel="stylesheet" type="text/css" href="../../../../../css/custom-jekyll/tags.css">




<meta name="description" content="Generating Reference Documentation for kubectl Commands" />
<meta property="og:description" content="Generating Reference Documentation for kubectl Commands" />

<meta property="og:url" content="https://kubernetes.io/docs/home/contribute/generated-reference/kubectl/" />
<meta property="og:title" content="Generating Reference Documentation for kubectl Commands - Kubernetes" />

<script
src="https://code.jquery.com/jquery-3.2.1.min.js"
integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4="
crossorigin="anonymous"></script>
<script
src="https://code.jquery.com/ui/1.12.1/jquery-ui.min.js"
integrity="sha256-VazP97ZCwtekAsvgPBSUwPFKdrwD3unUfSGVYrahUqU="
crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/sweetalert/1.1.3/sweetalert.min.js"></script>
<script src="../../../../../js/script.js"></script>
<script src="../../../../../js/custom-jekyll/tags.js"></script>


	</head>
	<body>
		<div id="cellophane" onclick="kub.toggleMenu()"></div>

<header>
    <a href="../../../../../index.html" class="logo"></a>

    <div class="nav-buttons" data-auto-burger="primary">
        <ul class="global-nav">
            
            
            <li><a href="../../../../home.1">Documentation</a></li>
            
            <li><a href="../../../../../blog/index.html">Blog</a></li>
            
            <li><a href="../../../../../partners/index.html">Partners</a></li>
            
            <li><a href="../../../../../community/index.html">Community</a></li>
            
            <li><a href="../../../../../case-studies/index.html">Case Studies</a></li>
            
            
             <li>
                <a href="index.html#">
                    English <span class="ui-icon ui-icon-carat-1-s"></span>
                </a>
                <ul>
                
                    <li><a href="../../../../../zh/index.html">中文 Chinese</a></li>
                
                    <li><a href="../../../../../ko/index.html">한국어 Korean</a></li>
                
                </ul>
            </li>
         
            <li>
                <a href="index.html#">
                    v1.11 <span class="ui-icon ui-icon-carat-1-s"></span>
                </a>
                <ul>
                
                    <li><a href="https://kubernetes.io">v1.12</a></li>
                
                    <li><a href="../../../../../index.html">v1.11</a></li>
                
                    <li><a href="https://v1-10.docs.kubernetes.io">v1.10</a></li>
                
                    <li><a href="https://v1-9.docs.kubernetes.io">v1.9</a></li>
                
                </ul>
            </li>
        </ul>
        
        <a href="../../../../tutorials/kubernetes-basics/index.html" class="button" id="tryKubernetes" data-auto-burger-exclude>Try Kubernetes</a>
        <button id="hamburger" onclick="kub.toggleMenu()" data-auto-burger-exclude><div></div></button>
    </div>

    <nav id="mainNav">
        <main data-auto-burger="primary">
        <div class="nav-box">
            <h3><a href="../../../../tutorials/stateless-application/hello-minikube/index.html">Get Started</a></h3>
            <p>Ready to get your hands dirty? Build a simple Kubernetes cluster that runs "Hello World" for Node.js.</p>
        </div>
        <div class="nav-box">
            <h3><a href="../../../../home.1">Documentation</a></h3>
            <p>Learn how to use Kubernetes with the use of walkthroughs, samples, and reference documentation. You can even <a href="../../../../../editdocs/index.html" data-auto-burger-exclude>help contribute to the docs</a>!</p>
        </div>
        <div class="nav-box">
            <h3><a href="../../../../../community/index.html">Community</a></h3>
            <p>If you need help, you can connect with other Kubernetes users and the Kubernetes authors, attend community events, and watch video presentations from around the web.</p>
        </div>
        <div class="nav-box">
            <h3><a href="../../../../../blog/index.html">Blog</a></h3>
            <p>Read the latest news for Kubernetes and the containers space in general, and get technical how-tos hot off the presses.</p>
        </div>
        </main>
        <main data-auto-burger="primary">
        <div class="left">
            <h5 class="github-invite">Interested in hacking on the core Kubernetes code base?</h5>
            <a href="https://github.com/kubernetes/kubernetes" class="button" data-auto-burger-exclude>View On Github</a>
        </div>

        <div class="right">
            <h5 class="github-invite">Explore the community</h5>
            <div class="social">
                <a href="https://twitter.com/kubernetesio" class="twitter"><span>Twitter</span></a>
                <a href="https://github.com/kubernetes/kubernetes" class="github"><span>Github</span></a>
                <a href="http://slack.k8s.io/" class="slack"><span>Slack</span></a>
                <a href="http://stackoverflow.com/questions/tagged/kubernetes" class="stack-overflow"><span>Stack Overflow</span></a>
                <a href="https://discuss.kubernetes.io" class="mailing-list"><span>Forum</span></a>
                <a href="https://calendar.google.com/calendar/embed?src=nt2tcnbtbied3l6gi2h29slvc0%40group.calendar.google.com" class="calendar"><span>Events Calendar</span></a>
            </div>
        </div>
        <div class="clear" style="clear: both"></div>
        </main>
    </nav>
</header>

		
		
		<section id="hero" class="light-text no-sub">
			





<h1></h1>
<h5></h5>












<div id="vendorStrip" class="light-text">
	<ul>
		
		
		<li><a href="../../../../home.1" class="YAH">DOCUMENTATION</a></li>
		
		
		<li><a href="../../../../setup/index.html">SETUP</a></li>
		
		
		<li><a href="../../../../concepts/index.html">CONCEPTS</a></li>
		
		
		<li><a href="../../../../tasks/index.html">TASKS</a></li>
		
		
		<li><a href="../../../../tutorials/index.html">TUTORIALS</a></li>
		
		
		<li><a href="../../../../reference.1">REFERENCE</a></li>
		
	</ul>
	<div id="searchBox">
		<input type="text" id="search" placeholder="Search" onkeydown="if (event.keyCode==13) window.location.replace('/docs/search/?q=' + this.value)" autofocus="autofocus">
	</div>
</div>

		</section>
		
		
<section id="deprecationWarning">
  <main>
    <div class="content deprecation-warning">
      <h3>
        Documentation for Kubernetes v1.11 is no longer actively maintained. The version you are currently viewing is a static snapshot.
        For up-to-date documentation, see the <a href="https://kubernetes.io/docs/home/">latest</a> version.
      </h3>
    </div>
  </main>
</section>


		<section id="encyclopedia">
			
<div id="docsToc">
     <div class="pi-accordion">
    	
        
        
        
        
        
         
             
                 
                          
                          
                 
             
         
             
         
             
         
             
         
             
         
             
         
             
         
             
         
         
        
        <a class="item" data-title="Documentation" href="../../../../home.1"></a>

	
	
		
		
	<div class="item" data-title="Contributing to the Kubernetes Docs">
		<div class="container">
		
		
	
	
		
		
<a class="item" data-title="Content Organization" href="../../content-organization/index.html"></a>

		
	
		
		
<a class="item" data-title="Creating a Documentation Pull Request" href="../../stage-documentation-changes/index.html"></a>

		
	
		
		
<a class="item" data-title="Custom Hugo Shortcodes" href="../../includes.1"></a>

		
	
		
		
<a class="item" data-title="Documentation Style Guide" href="../../style-guide.1"></a>

		
	
		
		
<a class="item" data-title="Generating Reference Documentation for Kubernetes Federation API" href="../federation-api/index.html"></a>

		
	
		
		
<a class="item" data-title="Generating Reference Documentation for kubectl Commands" href="index.html"></a>

		
	
		
		
<a class="item" data-title="Generating Reference Documentation for the Kubernetes API" href="../kubernetes-api/index.html"></a>

		
	
		
		
<a class="item" data-title="Generating Reference Pages for Kubernetes Components and Tools" href="../kubernetes-components/index.html"></a>

		
	
		
		
<a class="item" data-title="Localizing Kubernetes Documentation" href="../../localization/index.html"></a>

		
	
		
		
<a class="item" data-title="Participating in SIG-DOCS" href="../../participating/index.html"></a>

		
	
		
		
<a class="item" data-title="Reviewing Documentation Issues" href="../../review-issues/index.html"></a>

		
	
		
		
<a class="item" data-title="Using Page Templates" href="../../page-templates/index.html"></a>

		
	
		
		
<a class="item" data-title="Writing a Blog Post" href="../../blog-post/index.html"></a>

		
	
		
		
<a class="item" data-title="Writing a New Topic" href="../../write-new-topic/index.html"></a>

		
	

		</div>
	</div>

		
	
		
		
<a class="item" data-title="Supported Versions of the Kubernetes Documentation" href="../../../supported-doc-versions/index.html"></a>

		
	






     </div> 
    <button class="push-menu-close-button" onclick="kub.toggleToc()"></button>
</div> 

			<div id="docsContent">
				
<p><a href="../../../../editdocs#docs/home/contribute/generated-reference/kubectl.md" id="editPageButton">Edit This Page</a></p>

<h1>Generating Reference Documentation for kubectl Commands</h1>




<p>This page shows how to automatically generate reference pages for the
commands provided by the <code>kubectl</code> tool.</p>

<blockquote class="note">
  <div><strong>Note:</strong>
This topic shows how to generate reference documentation for
<a href="../../../../reference/generated/kubectl/kubectl/index.html">kubectl commands</a>
like
<a href="../../../../reference/generated/kubectl/kubectl/index.html#apply">kubectl apply</a> and
<a href="../../../../reference/generated/kubectl/kubectl/index.html#taint">kubectl taint</a>.
This topic does not show how to generate the
<a href="../../../../reference/generated/kubectl/kubectl/index.html">kubectl</a>
options reference page. For instructions on how to generate the kubectl options
reference page, see
<a href="../kubernetes-components/index.html">Generating Reference Pages for Kubernetes Components and Tools</a>.</div>
</blockquote>











<ul id="markdown-toc">










<li><a href="index.html#before-you-begin">Before you begin</a></li>












<li><a href="index.html#getting-three-repositories">Getting three repositories</a></li>




<li><a href="index.html#editing-the-kubectl-source-code">Editing the kubectl source code</a></li>




<li><a href="index.html#cherry-picking-your-change-into-a-release-branch">Cherry picking your change into a release branch</a></li>




<li><a href="index.html#editing-makefile">Editing Makefile</a></li>




<li><a href="index.html#building-the-brodocs-image">Building the brodocs image</a></li>




<li><a href="index.html#creating-a-version-directory">Creating a version directory</a></li>




<li><a href="index.html#checking-out-a-branch-in-kubernetes-kubernetes">Checking out a branch in kubernetes/kubernetes</a></li>




<li><a href="index.html#running-the-doc-generation-code">Running the doc generation code</a></li>




<li><a href="index.html#locate-the-generated-files">Locate the generated files</a></li>




<li><a href="index.html#copying-files-to-the-kubernetes-website-repository">Copying files to the kubernetes/website repository</a></li>




<li><a href="index.html#adding-and-committing-changes-in-kubernetes-website">Adding and committing changes in kubernetes/website</a></li>




<li><a href="index.html#creating-a-pull-request">Creating a pull request</a></li>




























<li><a href="index.html#what-s-next">What's next</a></li>



</ul>



<h2 id="before-you-begin">Before you begin</h2>
<ul>
<li><p>You need to have
<a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git" target="_blank">Git</a>
installed.</p></li>

<li><p>You need to have
<a href="https://golang.org/doc/install" target="_blank">Golang</a> version 1.9.1 or later installed,
and your <code>$GOPATH</code> environment variable must be set.</p></li>

<li><p>You need to have
<a href="https://docs.docker.com/engine/installation/" target="_blank">Docker</a> installed.</p></li>

<li><p>You need to know how to create a pull request to a GitHub repository.
Typically, this involves creating a fork of the repository. For more
information, see
<a href="../../stage-documentation-changes/index.html">Creating a Documentation Pull Request</a> and
<a href="https://gist.github.com/Chaser324/ce0505fbed06b947d962" target="_blank">GitHub Standard Fork &amp; Pull Request Workflow</a>.</p></li>
</ul>




<h2 id="getting-three-repositories">Getting three repositories</h2>

<p>If you don&rsquo;t already have the kubernetes/kubernetes repository, get it now:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">mkdir <span style="color:#b8860b">$GOPATH</span>/src
<span style="color:#a2f">cd</span> <span style="color:#b8860b">$GOPATH</span>/src
go get github.com/kubernetes/kubernetes</code></pre></div>
<p>Determine the base directory of your clone of the
<a href="https://github.com/kubernetes/kubernetes" target="_blank">kubernetes/kubernetes</a> repository.
For example, if you followed the preceding step to get the repository, your
base directory is <code>$GOPATH/src/github.com/kubernetes/kubernetes.</code>
The remaining steps refer to your base directory as <code>&lt;k8s-base&gt;</code>.</p>

<p>If you don&rsquo;t already have the kubernetes/website repository, get it now:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">mkdir <span style="color:#b8860b">$GOPATH</span>/src
<span style="color:#a2f">cd</span> <span style="color:#b8860b">$GOPATH</span>/src
go get github.com/kubernetes/website</code></pre></div>
<p>Determine the base directory of your clone of the
<a href="https://github.com/kubernetes/website" target="_blank">kubernetes/website</a> repository.
For example, if you followed the preceding step to get the repository, your
base directory is <code>$GOPATH/src/github.com/kubernetes/website.</code>
The remaining steps refer to your base directory as <code>&lt;web-base&gt;</code>.</p>

<p>If you don&rsquo;t already have the kubernetes-incubator/reference-docs repository, get it now:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">mkdir <span style="color:#b8860b">$GOPATH</span>/src
<span style="color:#a2f">cd</span> <span style="color:#b8860b">$GOPATH</span>/src
go get github.com/kubernetes-incubator/reference-docs</code></pre></div>
<p>Determine the base directory of your clone of the
<a href="https://github.com/kubernetes-incubator/reference-docs" target="_blank">kubernetes-incubator/reference-docs</a> repository.
For example, if you followed the preceding step to get the repository, your
base directory is <code>$GOPATH/src/github.com/kubernetes-incubator/reference-docs.</code>
The remaining steps refer to your base directory as <code>&lt;rdocs-base&gt;</code>.</p>

<p>In your local kubernetes/kubernetes repository, check out the branch of interest,
and make sure it is up to date. For example, if you want to generate docs for
Kubernetes 1.9, you could use these commands:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell"><span style="color:#a2f">cd</span> &lt;k8s-base&gt;
git checkout release-1.9
git pull https://github.com/kubernetes/kubernetes release-1.9</code></pre></div>
<h2 id="editing-the-kubectl-source-code">Editing the kubectl source code</h2>

<p>The reference documentation for the kubectl commands is automatically generated from
kubectl source code. If you want to change the reference documentation, the first step
is to change one or more comments in the kubectl source code. Make the change in your
local kubernetes/kubernetes repository, and then submit a pull request to the master branch of
<a href="https://github.com/kubernetes/kubernetes" target="_blank">github.com/kubernetes/kubernetes</a>.</p>

<p><a href="https://github.com/kubernetes/kubernetes/pull/56673/files" target="_blank">PR 56673</a>
is an example of a pull request that fixes a typo in the kubectl source code.</p>

<p>Monitor your pull request, and respond to reviewer comments. Continue to monitor your
pull request until it is merged into the master branch of the kubernetes/kubernetes repository.</p>

<h2 id="cherry-picking-your-change-into-a-release-branch">Cherry picking your change into a release branch</h2>

<p>Your change is now in the master branch, which is used for development of the next
Kubernetes release. If you want your change to appear in the docs for a Kubernetes
version that has already been released, you need to propose that your change be
cherry picked into the release branch.</p>

<p>For example, suppose the master branch is being used to develop Kubernetes 1.10,
and you want to backport your change to the release-1.9 branch. For instructions
on how to do this, see
<a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md" target="_blank">Propose a Cherry Pick</a>.</p>

<p>Monitor your cherry-pick pull request until it is merged into the release branch.</p>

<blockquote class="note">
  <div><strong>Note:</strong>
Proposing a cherry pick requires that you have permission to set a label and a
milestone in your pull request. If you don’t have those permissions, you will
need to work with someone who can set the label and milestone for you.</div>
</blockquote>

<h2 id="editing-makefile">Editing Makefile</h2>

<p>Go to <code>&lt;rdocs-base&gt;</code>, and open <code>Makefile</code> for editing:</p>

<p>Set <code>K8SROOT</code> to the base directory of your local kubernetes/kubernetes
repository. Set <code>WEBROOT</code> to the base directory of your local kubernetes/website repository.
Set <code>MINOR_VERSION</code> to the minor version of the docs you want to build. For example,
if you want to build docs for Kubernetes 1.9, set <code>MINOR_VERSION</code> to 9. Save and close <code>Makefile</code>.</p>

<h2 id="building-the-brodocs-image">Building the brodocs image</h2>

<p>The doc generation code requires the <code>pwittrock/brodocs</code> Docker image.</p>

<p>This command creates the <code>pwittrock/brodocs</code> Docker image. It also tries to push the image to
DockerHub, but it&rsquo;s OK if that step fails. As long as you have the image locally, the code generation
can succeed.</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">make brodocs</code></pre></div>
<p>Verify that you have the brodocs image:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">docker images</code></pre></div>
<p>The output shows <code>pwittrock/brodocs</code> as one of the available images:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">REPOSITORY          TAG                 IMAGE ID            CREATED             SIZE
pwittrock/brodocs   latest              999d34a50d56        <span style="color:#666">5</span> weeks ago         714MB</code></pre></div>
<h2 id="creating-a-version-directory">Creating a version directory</h2>

<p>In the <code>gen-kubectldocs/generators</code> directory, if you do not already
have a directory named <code>v1_MINOR_VERSION</code>, create one now by copying the directory
for the previous version. For example, suppose you want to generate docs for
Kubernetes 1.9, but you don&rsquo;t already have a <code>v1_9</code> directory. Then you could
create and populate a <code>v1_9</code> directory by running these commands:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">mkdir gen-kubectldocs/generators/v1_9
cp -r gen-kubectldocs/generators/v1_8/* gen-kubectldocs/generators/v1_9</code></pre></div>
<h2 id="checking-out-a-branch-in-kubernetes-kubernetes">Checking out a branch in kubernetes/kubernetes</h2>

<p>In you local kubernetes/kubernetes repository, checkout the branch that has
the version of Kubernetes that you want to document. For example, if you want
to generate docs for Kubernetes 1.9, checkout the release-1.9 branch. Make sure
you local branch is up to date.</p>

<h2 id="running-the-doc-generation-code">Running the doc generation code</h2>

<p>In you local kubernetes-incubator/reference-docs repository, build and run the
doc generation code. You might need to run the command as root:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell"><span style="color:#a2f">cd</span> &lt;rdocs-base&gt;
make cli</code></pre></div>
<h2 id="locate-the-generated-files">Locate the generated files</h2>

<p>These two files are the primary output of a successful build. Verify that they exist:</p>

<ul>
<li><code>&lt;rdocs-base&gt;/gen-kubectldocs/generators/build/index.html</code></li>
<li><code>&lt;rdocs-base&gt;/gen-kubectldocs/generators/build/navData.js</code></li>
</ul>

<h2 id="copying-files-to-the-kubernetes-website-repository">Copying files to the kubernetes/website repository</h2>

<p>Copy the generated files from your local kubernetes-incubator/reference-docs
repository to your local kubernetes/website repository.</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell"><span style="color:#a2f">cd</span> &lt;rdocs-base&gt;
make copycli</code></pre></div>
<h2 id="adding-and-committing-changes-in-kubernetes-website">Adding and committing changes in kubernetes/website</h2>

<p>List the files that were generated and copied to the <code>kubernetes/website</code>
repository:</p>

<pre><code>cd &lt;web-base&gt;
git status
</code></pre>

<p>The output shows the new and modified files. For example, the output
might look like this:</p>
<div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">modified: docs/reference/generated/kubectl/kubectl-commands.html
modified: docs/reference/generated/kubectl/navData.js</code></pre></div>
<p>Run <code>git add</code> and <code>git commit</code> to commit the files.</p>

<h2 id="creating-a-pull-request">Creating a pull request</h2>

<p>Create a pull request to the <code>kubernetes/website</code> repository. Monitor your
pull request, and respond to review comments as needed. Continue to monitor
your pull request until it is merged.</p>

<p>A few minutes after your pull request is merged, your updated reference
topics will be visible in the
<a href="../../../../home.1">published documentation</a>.</p>

















<h2 id="what-s-next">What&#39;s next</h2>
<ul>
<li><a href="../kubernetes-components/index.html">Generating Reference Documentation for Kubernetes Components and Tools</a></li>
<li><a href="../kubernetes-api/index.html">Generating Reference Documentation for the Kubernetes API</a></li>
<li><a href="../federation-api/index.html">Generating Reference Documentation for the Kubernetes Federation API</a></li>
</ul>






				<div class="issue-button-container">
					<p><a href="index.html"><img src="https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/home/contribute/generated-reference/kubectl.md?pixel" alt="Analytics" /></a></p>
					
					
					<script type="text/javascript">
					PDRTJS_settings_8345992 = {
					"id" : "8345992",
					"unique_id" : "\/docs\/home\/contribute\/generated-reference\/kubectl\/",
					"title" : "Generating Reference Documentation for kubectl Commands",
					"permalink" : "https:\/\/kubernetes.io\/docs\/home\/contribute\/generated-reference\/kubectl\/"
					};
					(function(d,c,j){if(!document.getElementById(j)){var pd=d.createElement(c),s;pd.id=j;pd.src=('https:'==document.location.protocol)?'https://polldaddy.com/js/rating/rating.js':'http://i0.poll.fm/js/rating/rating.js';s=document.getElementsByTagName(c)[0];s.parentNode.insertBefore(pd,s);}}(document,'script','pd-rating-js'));
					</script>
					<a href="index.html" onclick="window.open('https://github.com/kubernetes/website/issues/new?title=Issue%20with%20' +
					'k8s.io'+window.location.pathname)" class="button issue">Create an Issue</a>
					
					
					
					<a href="../../../../editdocs#docs/home/contribute/generated-reference/kubectl.md" class="button issue">Edit this Page</a>
					
				</div>
			</div>
		</section>
		<footer>
    <main class="light-text">
        <nav>
            
            
            
            <a href="../../../../home.1">Documentation</a>
            
            <a href="../../../../../blog/index.html">Blog</a>
            
            <a href="../../../../../partners/index.html">Partners</a>
            
            <a href="../../../../../community/index.html">Community</a>
            
            <a href="../../../../../case-studies/index.html">Case Studies</a>
            
        </nav>
        <div class="social">
            <div>
                <a href="https://twitter.com/kubernetesio" class="twitter"><span>twitter</span></a>
                <a href="https://github.com/kubernetes/kubernetes" class="github"><span>Github</span></a>
                <a href="http://slack.k8s.io/" class="slack"><span>Slack</span></a>
            </div>
            <div>
                <a href="http://stackoverflow.com/questions/tagged/kubernetes" class="stack-overflow"><span>Stack Overflow</span></a>
                <a href="https://discuss.kubernetes.io" class="mailing-list"><span>Forum</span></a>
                <a href="https://calendar.google.com/calendar/embed?src=nt2tcnbtbied3l6gi2h29slvc0%40group.calendar.google.com" class="calendar"><span>Events Calendar</span></a>
            </div>
            <div>
                <a href="../../../../getting-started-guides/index.html" class="button">Get Kubernetes</a>
                <a href="https://git.k8s.io/community/contributors/guide" class="button">Contribute</a>
            </div>
        </div>
        <div id="miceType" class="center">
            &copy; 2018 The Kubernetes Authors | Documentation Distributed under <a href="https://git.k8s.io/website/LICENSE" class="light-text">CC BY 4.0</a>
        </div>
        <div id="miceType" class="center">
            Copyright &copy; 2018 The Linux Foundation&reg;. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage" class="light-text">Trademark Usage page</a>
        </div>
    </main>
</footer>

		<button class="flyout-button" onclick="kub.toggleToc()"></button>

<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-36037335-10', 'auto');
ga('send', 'pageview');


(function () {
    window.addEventListener('DOMContentLoaded', init)

        
        function init() {
            window.removeEventListener('DOMContentLoaded', init)
                hideNav()
        }

    function hideNav(toc){
        if (!toc) toc = document.querySelector('#docsToc')
        if (!toc) return
            var container = toc.querySelector('.container')

                
                if (container) {
                    if (container.childElementCount === 0 || toc.querySelectorAll('a.item').length === 1) {
                        toc.style.display = 'none'
                            document.getElementById('docsContent').style.width = '100%'
                    }
                } else {
                    requestAnimationFrame(function () {
                        hideNav(toc)
                    })
                }
    }
})();
</script>



	</body>
</html>